home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1996 November / macformat-043.iso / mac / Shareware Plus / Developers / Sprite Animation Toolkit 2.3.8 / SAT CW Lib ƒ / SAT.h < prev    next >
Encoding:
C/C++ Source or Header  |  1996-06-20  |  10.1 KB  |  281 lines  |  [TEXT/KAHL]
  1. /* #include file for the C interface to SAT */
  2.  
  3. #pragma once
  4. #ifdef __cplusplus
  5. extern "C" {
  6. #endif
  7.  
  8. #pragma options align=mac68k
  9.  
  10. #ifndef true
  11. #define true 1
  12. #endif
  13.  
  14. #ifndef false
  15. #define false 0
  16. #endif
  17.  
  18. #ifndef nil
  19. #define nil 0L
  20. #endif
  21.  
  22.     typedef struct SATPort {
  23.         GrafPtr        port;
  24.         GDHandle    device;
  25.         Ptr                rows;
  26.         Rect            bounds;
  27.         Ptr                baseAddr;
  28.         short            rowBytes;
  29.     } SATPort;
  30.  
  31.     typedef struct Face {
  32.         char            *colorData;
  33.         short            resNum;
  34.         BitMap            iconMask;
  35.         short            rowBytes; /* Note! No flags in the highest bits!*/
  36.         struct face        *next;
  37.         RgnHandle        maskRgn;
  38.         Ptr    rows, maskRows;
  39.         pascal void (*redrawProc)(struct Face *, short);    //Called on depth changes, not needed if the face is loaded from a cicn}
  40.         pascal void (*drawProc)(struct Face *, RgnHandle, SATPort *, Point srcPt, Point dstPt, short width, short height); // Untested from C so far!
  41.         } Face, *FacePtr;
  42.  
  43.  
  44.     typedef struct Sprite {
  45. /* Variables that you should change as appropriate */
  46.         short            kind;
  47.         Point            position;
  48.         Rect            hotRect, hotRect2;    // Only change hotRect, SAT handles hotRect2
  49.         FacePtr            face;
  50.         pascal void        (*task) (struct Sprite *);
  51.         pascal void        (*hitTask) (struct Sprite *, struct Sprite *);
  52.         pascal void        (*destructTask) (struct Sprite *);
  53.         RgnHandle        clip; /* Clip region to be used when this sprite is drawn. */
  54. /* SAT variables that you shouldn't change: */
  55.         Point            oldpos;
  56.         struct Sprite    *next, *prev;
  57.         Rect            r, oldr;
  58.         FacePtr        oldFace;            //Used by RunSAT2
  59.         Boolean        dirty;        //Used by RunSAT2
  60. /* Variables for free use by the application: */
  61.         short        layer;
  62. #ifdef SATCPP_H
  63.       Ptr            spriteBegin;
  64. #else
  65.         Point            speed;
  66.         short        mode;
  67.         Ptr            appPtr;
  68.         long            appLong;
  69. #endif
  70.         } Sprite, *SpritePtr;
  71.  
  72.  
  73. typedef struct{
  74.         short    patternType;     /* 1 = Pattern, PatHandle, 2 = PixPat, PixPatHandle */
  75.         PixPatHandle    thePat;         /* or PatHandle */
  76.         }    SATPattern, *SATPatPtr, **SATPatHandle;
  77.  
  78. #define    UpdatePtr    Ptr
  79.  
  80. typedef struct {
  81.         SATPort        wind;
  82.         short            offSizeH, offSizeV;
  83.         SATPort        offScreen, backScreen;
  84.         long            ox, oy;
  85.         short            pict, bwpict;
  86.         Boolean        fitThePICTs;
  87.         short            sorting, collision, searchWidth;
  88.         PixMapHandle    screen;
  89.         Rect            bounds;
  90.         short            initDepth;
  91.         pascal Boolean    (*synchHook) ();
  92.         SpritePtr        sRoot;
  93.         UpdatePtr        updateRoot;
  94.         Boolean        anyMonsters;
  95.  
  96.         CGrafPtr        ditherOff;
  97.         GDHandle        ditherOffGD;
  98.         SATPort            iconPort;
  99.         SATPort            iconPort2;
  100.         GrafPtr            bwIconPort;
  101.  
  102. /* Environment-independent globals: */
  103.         FacePtr            faceRoot;    /* Face list */
  104.         Boolean            colorFlag; /* Is this Mac color capable? */
  105. /*Blitters! You should not change these fields yourself. (Possibly for installing a blitter in your program code.)*/
  106.         ProcPtr    rectBlit1, maskBlit1;                //{Supplied - this is either RBlt/MBlt 0 or 1}
  107.         ProcPtr    rectBlit2, maskBlit2;                //{Will probably never be used}
  108.         ProcPtr    rectBlit4, maskBlit4;                //{Supplied}
  109.         ProcPtr    rectBlit8, maskBlit8;                //{Supplied}
  110.         ProcPtr    rectBlit16, maskBlit16;            //{Not supplied}
  111.         ProcPtr    rectBlit32, maskBlit32;            //{Not supplied}
  112.         ProcPtr    curRectBlit, curMaskBlit;        //{Currently selected fast blitter}
  113.  
  114.         Rect    screenLocalDrawingArea;
  115.         SpritePtr    trashList;
  116.         } SATglobalsRec;
  117.  
  118. /* Constants for SATConfigure */
  119.     enum{kVPositionSort=0, kLayerSort, kNoSort};
  120.     enum{kKindCollision=0, kForwardCollision, kBackwardCollision, kNoCollision, kForwardOneCollision};
  121.  
  122. // For CodeWarrior C, 68k (due to capitalization problems):
  123. // Note: If you have link problems associated with gSAT, you may have
  124. // to activate or deactivate this #define!
  125. #ifdef __MWERKS__
  126. #ifndef powerc
  127. #define gSAT GSAT
  128. #endif
  129. #endif
  130.  
  131. /* Global variables */
  132.     extern SATglobalsRec    gSAT;    /* Most globals */
  133.     extern pascal void        (*gSoundErrorProc)(OSErr); /* Sound errors reported here */
  134.  
  135. /* SAT routines */
  136.  
  137.     typedef pascal void (*TaskPtr)(SpritePtr);
  138.     typedef pascal Boolean (*SynchPtr)(void);
  139.     typedef pascal void (*EmergencyPtr)(void);
  140.  
  141. /* Initialization */
  142.     pascal void SATConfigure(Boolean, short, short, short);
  143.     pascal void SATInit (short, short, short, short);
  144.     pascal void SATCustomInit (short, short, Rect *, WindowPtr, GDHandle, Boolean, Boolean, Boolean, Boolean, Boolean);
  145. /* Maintainance, background manipulation etc. */
  146.     pascal Boolean SATDepthChangeTest(void);
  147.     pascal void SATDrawPICTs (short, short);
  148.     pascal void SATRedraw(void);
  149. /* Drawing */
  150.     pascal void SATPlotFace(FacePtr, SATPort*, Point, Boolean); /*Draw a Face (icon).*/
  151.     pascal void SATPlotFaceToScreen(FacePtr, Point, Boolean);
  152.     pascal void SATCopyBits(SATPort*, SATPort*, GDHandle, Rect*, Rect*, Boolean);
  153.     pascal void SATCopyBitsToScreen(SATPort*, Rect*, Rect*, Boolean);
  154.     pascal void SATBackChanged (Rect *); /*Tell SAT about changes in BackScreen*/
  155. /* SetPort replacements */
  156.     pascal void SATGetPort (SATPort*);
  157.     pascal void SATSetPort (SATPort*);
  158.     pascal void SATSetPortOffScreen(void); /*Use before Quick-Drawing on offScreen*/
  159.     pascal void SATSetPortBackScreen(void); /*Use before Quick-Drawing on BackScreen*/
  160.     pascal void SATSetPortScreen(void); /*Use to restore after drawing off/backscreen*/
  161. /* Sprite handling */
  162.     pascal FacePtr SATGetFace (short);
  163.     pascal void SATDisposeFace (FacePtr);
  164.     pascal SpritePtr SATNewSprite (short,short,short, TaskPtr); // (*void)(SpritePtr));
  165.     pascal SpritePtr SATNewSpriteAfter (SpritePtr,short,short,short, TaskPtr);
  166.     pascal void SATKillSprite (SpritePtr);
  167. /* Animating */
  168.     pascal void SATRun (Boolean);
  169.     pascal void    SATRun2 (Boolean); //Alternate routine for allowing resting sprites}
  170. /* Advanced special-purpose calls */
  171.     pascal void SATInstallSynch (SynchPtr);
  172.     pascal void SATInstallEmergency (EmergencyPtr);
  173.     pascal void SATSetSpriteRecSize (long);
  174.     pascal void SATSkip(void);
  175.     pascal void SATKill(void); /*Dispose of offscreen buffers to allow re-init*/
  176.     pascal void SATWindMoved(void);            /* For programs with moveable animation window and fast animation */
  177. /* Offscreen - use only if you need an *extra* offscreen buffer. These calls are likely to change in the future!*/
  178.     pascal void SATMakeOffscreen (SATPort*, Rect*);    /*Make offscreen buffer in current screen depth and CLUT.*/
  179.     pascal void SATDisposeOffScreen (SATPort*);        /*Get rid of offscreen*/
  180.     pascal OSErr CreateOffScreen (Rect*, short, CTabHandle, CGrafPtr*, GDHandle*); /*From Principia Offscreen*/
  181.     pascal void DisposeOffScreen (CGrafPtr, GDHandle);            /*From Principia Offscreen*/
  182. /* Face manipulation */
  183.     pascal void SATSetPortMask (FacePtr);
  184.     pascal void SATSetPortFace (FacePtr);
  185.     pascal void SATSetPortFace2 (FacePtr);
  186.     pascal FacePtr SATNewFace (Rect*);
  187.     pascal void SATChangedFace (FacePtr);
  188.  
  189. /* Most common old names, uncomment for compatibility with old programs */
  190. // #define ConfigureSAT        SATConfigure
  191. // #define InitSAT            SATInit
  192. // #define CustomInitSAT    SATCustomInit
  193. // #define KillSAT            SATKill
  194. // #define RunSAT            SATRun
  195. // #define SkipSAT            SATSkip
  196. // #define GetFace            SATGetFace
  197. // #define DisposeFace        SATDisposeFace
  198. // #define NewSprite        SATNewSprite
  199. // #define NewSpriteAfter    SATNewSpriteAfter
  200. // #define KillSprite        SATKillSprite
  201. // #define NewFace            SATNewFace
  202. // #define ChangedFace        SATChangedFace
  203. // #define PeekOffscreen    SATRedraw
  204.  
  205. /* New procedures, EXPERIMENTAL, intended for making a C++ interface */
  206.     pascal SpritePtr SATNewSpritePP(SpritePtr, Ptr, short, short, short, TaskPtr);
  207.     pascal void SATCopySprite(SpritePtr, const Sprite *);
  208. //    pascal void SATCopySprite(SpritePtr, SpritePtr);
  209.     pascal FacePtr SATNewFacePP(Rect*, Ptr);
  210.     pascal FacePtr SATGetFacePP (short, Ptr);
  211.     pascal void SATCopyFace(FacePtr, const Face *);
  212. //    pascal void SATCopyFace(FacePtr, FacePtr);
  213.     pascal void SATDisposeFacePP (FacePtr);
  214.  
  215. /* Cicn utilities */
  216.     pascal CIconHandle SATGetCicn (short);
  217.     pascal void SATPlotCicn (CIconHandle, GrafPtr, GDHandle, Rect*);
  218.     pascal void SATDisposeCicn (CIconHandle);
  219.  
  220. /*Utilities*/
  221.     pascal void SATSetStrings (Str255, Str255, Str255, Str255, Str255, Str255, Str255, Str255);
  222.     pascal Boolean SATTrapAvailable (short);
  223.     pascal void SATDrawInt (short);
  224.     pascal void SATDrawLong (long);
  225.     pascal short SATRand (short);
  226.     pascal short SATRand10(void);
  227.     pascal short SATRand100(void);
  228.     pascal void SATReportStr (Str255);
  229.     pascal Boolean SATQuestionStr(Str255);
  230.     pascal void CheckNoMem (Ptr); /*If the Ptr is nil, out of memory emergency exit*/
  231.     pascal short SATFakeAlert (Str255, Str255, Str255, Str255, short, short, short, Str255, Str255, Str255);
  232.     pascal void SATSetMouse (Point);
  233.     pascal void SATInitToolbox(void);
  234.     pascal void SATGetVersion(Str255 versionString);
  235. /* Pattern utilities */
  236.     pascal void SATPenPat (SATPatHandle);
  237.     pascal void SATBackPat (SATPatHandle);
  238.     pascal SATPatHandle SATGetPat (short);
  239.     pascal void SATDisposePat (SATPatHandle);
  240. /* Menu bar utilities */
  241.     pascal void SATShowMBar(WindowPtr);
  242.     pascal void SATHideMBar(WindowPtr);
  243. /* PICT utilities */
  244.     pascal void SATGetandDrawPICTRes (short id);
  245.     pascal void SATGetandDrawPICTResInRect (short id, Rect *frame);
  246.     pascal void SATGetandCenterPICTResInRect (short id, Rect *frame);
  247. /*Sound*/
  248.     pascal void SATInitSound(void);            /* No longer necessary */
  249.     pascal void SATSoundPlay (Handle, short, Boolean);    /* Play sounds with priority handling */
  250.     pascal void SATSoundShutup(void);        /*Silence, dispose of sound channel*/
  251.     pascal void SATSoundEvents(void);        /* Call this once in a while when not calling RunSAT often */
  252.     pascal Boolean SATSoundDone(void);    /* Any sound going on?*/
  253.     pascal Handle SATGetSound (short);
  254.     pascal Handle SATGetNamedSound (Str255);
  255.     pascal void SATDisposeSound (Handle);
  256.     pascal void SATSoundOn(void);
  257.     pascal void SATSoundOff(void);
  258. /* Multi-channel sound routines */
  259.     pascal short SATSoundInitChannels (short);
  260.     pascal Boolean SATSoundDoneChannel (short);
  261.     pascal void SATSoundPlayChannel (Handle, short);
  262.     pascal void SATSoundReserveChannel (short, Boolean);
  263.     pascal void SATSoundShutupChannel (short);
  264.     pascal void SATPreloadChannels(void);
  265. /* Experimental, likely to be renamed/removed/changed: */
  266.     pascal void SATSoundPlay2 (Handle, short, Boolean,Boolean);
  267.     pascal void SATSoundPlayEasy (Handle, Boolean);
  268. /* More multi-channel: */
  269.     pascal int SATGetNumChannels(void);
  270.     pascal Ptr SATGetChannel (int);
  271. /* Customization */
  272.     pascal void SATSetSoundInitParams (long);
  273. /* Step-scrolling */
  274.     pascal Boolean SATStepScroll (Point viewPoint, short marginH, short marginV, short scrollSpeed);
  275.  
  276. #pragma options align=reset
  277.  
  278. #ifdef __cplusplus
  279. }
  280. #endif
  281.